Recipes draft #1003

martinosorb · 2024-07-03T19:00:55Z

I created this PR to check if it was possible to merge the Recipes version without too much pain, and so we can discuss whether this is a good choice.
Before merging we have a number of TODOs:

Ask @dpshelio if there are any objections to using their material and how we can acknowledge them
Ask @swcarpentry/git-novice-es-maintainers how much would this affect the Spanish language fork and whether they are ok with updating their translation accordingly
As @swcarpentry/git-novice-maintainers, consider if this is what we want to do, as opposed to other choices
Under suggestion from @kekoziar, avoid cocktails and use something alcohol-free instead
Gather opinions from the CAC @swcarpentry/governance-committee

Migrated old changes made to the styles lesson but as sandpaper This includes the changes done to: 5c3f297 ca6d833 376bc11

github-actions · 2024-07-03T19:01:10Z

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

🎯 correct output
🖼️ correct figures
❓ new warnings
‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/swcarpentry/git-novice/compare/md-outputs..md-outputs-PR-1003

The following changes were observed in the rendered markdown documents:

 02-setup.md                          |  12 +-
 03-create.md                         |  75 +++++------
 04-changes.md                        | 246 +++++++++++++++++++---------------
 05-history.md                        | 224 ++++++++++++++++---------------
 06-ignore.md                         | 100 +++++++-------
 07-github.md                         |  85 ++++++------
 08-collab.md                         |  45 ++++---
 09-conflict.md                       | 250 +++++++++++++++++++++--------------
 14-supplemental-rstudio.md           |   8 +-
 discuss.md                           | 130 +++++++++---------
 fig/git-freshly-made-github-repo.svg |   4 +-
 fig/github-collaboration.svg         |  10 +-
 fig/github-repo-after-first-push.svg |   6 +-
 index.md                             |   8 +-
 instructor-notes.md                  |   8 +-
 md5sum.txt                           |  24 ++--
 16 files changed, 666 insertions(+), 569 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-09-18 12:43:15 +0000

episodes/07-github.md

episodes/09-conflict.md

index.md

learners/discuss.md

episodes/05-history.md

learners/discuss.md

martinosorb · 2024-07-04T17:04:30Z

@nsoranzo thank you so much for your suggestions. After searching around for established conventions, I agree both with the idea of capitalizing Git and with using present tense rather than present continuous in commit messages. However, these are changes that are unrelated to this pull request. Any reason why you wanted to suggest this here? It would be best to create another PR after this one has been merged (if it's approved). Thank you though.

nsoranzo · 2024-07-04T17:32:20Z

@nsoranzo thank you so much for your suggestions. After searching around for established conventions, I agree both with the idea of capitalizing Git and with using present tense rather than present continuous in commit messages. However, these are changes that are unrelated to this pull request. Any reason why you wanted to suggest this here? It would be best to create another PR after this one has been merged (if it's approved). Thank you though.

Thanks for looking into my suggestions! I partially agree with your reply:

For capitalising Git, this is already the case in most of the episodes and my suggestions where only for a new callout, so I cannot do that in a separate PR. Actually I wanted to suggest that the new callout should go in a separate PR 😄
For the use of imperative rather than the -ing form, I can do that for the current version of the lesson, but then it would conflict with your changes here, let me know if that's your preferred choice.

tobyhodges

On the whole, this looks good and results in less of a change (in practical terms) than I had expected. I have suggested a minor change to the Markdown syntax used in the examples: having multiple h1 headings in a file is bad practice from an accessibility standpoint, so I have suggested h2 headings (##) instead.

A few other miscellaneous questions and suggestions too.

episodes/03-create.md

episodes/04-changes.md

episodes/09-conflict.md

learners/discuss.md

Co-authored-by: Toby Hodges <tobyhodges@carpentries.org>

Markdown accepts either `-` or `*` however, in this material, the `-` causes confussion when looking at diffs as you'd get things like: ```diff - avocado -- lemon +- lime ``` making the `-` from the diff misunderstood with the `-` of the list.

This is done to have files with a single heading as accessibility recommendations. A title is introduced (recipe title) and the ingredients and instructions are set as 2nd level headings.

tobyhodges · 2024-08-14T16:14:06Z

If and when #1013 is merged, I will be happy to approve this.

dpshelio · 2024-08-14T16:18:56Z

Ups! I didn't see your comment, @tobyhodges - I merged also #1012 into #1013 because it was producing a lot of merge conflicts. ~~Hopefully that doesn't change your mind~~ Oh! I saw it doesn't 😇

Co-authored-by: Nicola Soranzo <nicola.soranzo@earlham.ac.uk>

Co-authored-by: Toby Hodges <tobyhodges@carpentries.org>

martinosorb · 2024-08-14T16:46:04Z

I've incorporated the suggestions by @dpshelio, @nsoranzo, and @tobyhodges. The only conversation left is about the sentence "A supplemental episode to this lesson discusses advanced setup and concepts of SSH and key pairs, and other material supplemental to git related SSH" that was introduced, and probably refers to something internal to UCL, I'm guessing. I will now proceed and merge #1013. After that, we can all set a date for merging. At that point, I will rebase and fix the conflicts.

Modifies examples to include a single heading and changes md symbol used for listing items

dpshelio · 2024-08-14T17:16:57Z

Nothing to do with UCL 😇 - that was introduced in 2021 by @kekoziar
2b4bdb0#diff-6630f5f1e305bfd380d35f1f94de9c6c1c8f706ee2671c875f05db70b42f2dacR88-R90
and removed last year
d01e39b

MGomezN · 2024-08-14T17:19:19Z

Hello! I'm a git-novice-es-maintainer
I missed/forgot this 👇🏽 , but I'm happy to help update the Spanish version once this PR is approved.

Ask @swcarpentry/git-novice-es-maintainers how much would this affect the Spanish language fork and whether they are ok with updating their translation accordingly

…duced

jas58 · 2024-08-21T22:15:50Z

This is so cool! Thank you for the the revisions and work!

chennesy · 2024-09-13T15:40:16Z

These look like great improvements, many thanks to all who worked on them!
@kekoziar @martinosorb: is there a target date for approving the PR? I have instructors planning to teach this on Sept 26, and want to make sure we know which version will be live since these are pretty significant changes.

jas58 · 2024-09-13T17:33:15Z

Cody, It looks fairly complete and would be ready for teaching next week. Just a bit tricky to share the right website? ~~ jaws

…

On Fri, Sep 13, 2024, 10:40 AM Cody Hennesy ***@***.***> wrote: These look like great improvements, many thanks to all who worked on them! @kekoziar <https://github.com/kekoziar> @martinosorb <https://github.com/martinosorb>: is there a target date for approving the PR? I have instructors planning to teach this on Sept 26, and want to make sure we know which version will be live since these are pretty significant changes. — Reply to this email directly, view it on GitHub <#1003 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMT5MX5F6GDUE7GU4XDBGJLZWMBPPAVCNFSM6AAAAABKKEZRESVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNBZGI2DQMRRG4> . You are receiving this because you commented.Message ID: ***@***.***>

martinosorb · 2024-09-14T09:09:45Z

Paging @tobyhodges on timing. If you guys would like to have this version for your workshop, I think we could arrange to have it merged before then.

chennesy · 2024-09-16T15:50:24Z

Thanks @martinosorb @tobyhodges Our instructors noted they won't have much time to review the changes in their prep before their workshop so are wondering if it would be OK to wait until after Sept 26, 2024 1800 UTC to merge the PR?

martinosorb · 2024-09-18T12:36:11Z

@jas58 @chennesy, we will then merge between the 27th and 30th of September. Thanks.

learners/discuss.md

Co-authored-by: James Foster <38274066+jd-foster@users.noreply.github.com>

martinosorb · 2024-09-18T12:42:31Z

Thanks for catching that typo @jd-foster.

Auto-generated via {sandpaper} Source : ecbc85e Branch : main Author : Martino Sorbaro <martinosorb@users.noreply.github.com> Time : 2024-09-29 16:45:16 +0000 Message : Merge pull request #1003 from swcarpentry/recipes-draft Recipes draft

Auto-generated via {sandpaper} Source : d4dfd52 Branch : md-outputs Author : GitHub Actions <actions@github.com> Time : 2024-09-29 16:46:10 +0000 Message : markdown source builds Auto-generated via {sandpaper} Source : ecbc85e Branch : main Author : Martino Sorbaro <martinosorb@users.noreply.github.com> Time : 2024-09-29 16:45:16 +0000 Message : Merge pull request #1003 from swcarpentry/recipes-draft Recipes draft

dpshelio · 2024-09-29T19:00:14Z

🎉 🎆 🥳 👏 👏 👏 👏

dpshelio and others added 3 commits July 13, 2023 20:17

🥑-ise the lesson: from planets to recipes

231fb97

Migrated old changes made to the styles lesson but as sandpaper This includes the changes done to: 5c3f297 ca6d833 376bc11

merge recipes version from UCL

da3face

fixing the names for the changes in more recent commits

15d5684

github-actions bot pushed a commit that referenced this pull request Jul 3, 2024

differences for PR #1003

0f87afa

martinosorb added the type:discussion Discussion or feedback about the lesson label Jul 3, 2024

nsoranzo reviewed Jul 4, 2024

View reviewed changes

episodes/07-github.md Outdated Show resolved Hide resolved

nsoranzo reviewed Jul 4, 2024

View reviewed changes

undo change to README

b9264c5

github-actions bot pushed a commit that referenced this pull request Jul 5, 2024

differences for PR #1003

7533969

un-🍸 the lesson

1eabd6b

github-actions bot pushed a commit that referenced this pull request Jul 5, 2024

differences for PR #1003

86474ad

tobyhodges requested changes Jul 24, 2024

View reviewed changes

martinosorb and others added 3 commits August 5, 2024 10:57

Remove Dracula joke

2c983e7

Co-authored-by: Toby Hodges <tobyhodges@carpentries.org>

Modifies examples to include a single heading

50338c8

This is done to have files with a single heading as accessibility recommendations. A title is introduced (recipe title) and the ingredients and instructions are set as 2nd level headings.

dpshelio mentioned this pull request Aug 14, 2024

Modifies examples to include a single heading and changes md symbol used for listing items #1013

Merged

Merge branch 'list-md' into recipes-draft2

2dd3aa1

martinosorb and others added 4 commits August 14, 2024 18:24

Use present tense and capital letter in commit messages

7de60cb

Co-authored-by: Nicola Soranzo <nicola.soranzo@earlham.ac.uk>

Further capitalization suggestions by nsoranzo

5f03c1f

Co-authored-by: Nicola Soranzo <nicola.soranzo@earlham.ac.uk>

Change tomatos to tomatoes

7e18fdf

Co-authored-by: Toby Hodges <tobyhodges@carpentries.org>

Use output syntax highlighting for git status

eceba16

Co-authored-by: Toby Hodges <tobyhodges@carpentries.org>

Merge pull request #1013 from dpshelio/heading-sections

97c652f

Modifies examples to include a single heading and changes md symbol used for listing items

Merge branch 'main' into recipes-draft

f046672

martinosorb marked this pull request as ready for review August 15, 2024 14:34

martinosorb requested a review from tobyhodges August 15, 2024 14:34

github-actions bot pushed a commit that referenced this pull request Aug 15, 2024

differences for PR #1003

ac5aca8

remove reference to advanced ssh material that was mistakenly reintro…

f6cf2f9

…duced

martinosorb removed the type:discussion Discussion or feedback about the lesson label Aug 15, 2024

github-actions bot pushed a commit that referenced this pull request Aug 15, 2024

differences for PR #1003

fdf0c26

tobyhodges approved these changes Aug 15, 2024

View reviewed changes

jd-foster reviewed Sep 18, 2024

View reviewed changes

learners/discuss.md Outdated Show resolved Hide resolved

Update learners/discuss.md

11f8316

Co-authored-by: James Foster <38274066+jd-foster@users.noreply.github.com>

github-actions bot pushed a commit that referenced this pull request Sep 18, 2024

differences for PR #1003

a6e7b93

martinosorb merged commit ecbc85e into main Sep 29, 2024
3 checks passed

martinosorb deleted the recipes-draft branch September 29, 2024 16:45

sjvrijn mentioned this pull request Oct 16, 2024

Change Vlad/Mummy Planets story? esciencecenter-digital-skills/git-lesson#33

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Recipes draft #1003

Recipes draft #1003

martinosorb commented Jul 3, 2024 •

edited

Loading

github-actions bot commented Jul 3, 2024 •

edited

Loading

martinosorb commented Jul 4, 2024

nsoranzo commented Jul 4, 2024

tobyhodges left a comment

tobyhodges commented Aug 14, 2024

dpshelio commented Aug 14, 2024 •

edited

Loading

martinosorb commented Aug 14, 2024

dpshelio commented Aug 14, 2024

MGomezN commented Aug 14, 2024

jas58 commented Aug 21, 2024

chennesy commented Sep 13, 2024

jas58 commented Sep 13, 2024 via email

martinosorb commented Sep 14, 2024

chennesy commented Sep 16, 2024

martinosorb commented Sep 18, 2024

martinosorb commented Sep 18, 2024

dpshelio commented Sep 29, 2024

Recipes draft #1003

Recipes draft #1003

Conversation

martinosorb commented Jul 3, 2024 • edited Loading

github-actions bot commented Jul 3, 2024 • edited Loading

Thank you!

Rendered Changes

martinosorb commented Jul 4, 2024

nsoranzo commented Jul 4, 2024

tobyhodges left a comment

Choose a reason for hiding this comment

tobyhodges commented Aug 14, 2024

dpshelio commented Aug 14, 2024 • edited Loading

martinosorb commented Aug 14, 2024

dpshelio commented Aug 14, 2024

MGomezN commented Aug 14, 2024

jas58 commented Aug 21, 2024

chennesy commented Sep 13, 2024

jas58 commented Sep 13, 2024 via email

martinosorb commented Sep 14, 2024

chennesy commented Sep 16, 2024

martinosorb commented Sep 18, 2024

martinosorb commented Sep 18, 2024

dpshelio commented Sep 29, 2024

martinosorb commented Jul 3, 2024 •

edited

Loading

github-actions bot commented Jul 3, 2024 •

edited

Loading

dpshelio commented Aug 14, 2024 •

edited

Loading